docs(website): allow release-line snapshot refresh#461
Merged
Conversation
Signed-off-by: Roel de Cort <roel.decort@adfinis.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes the release-line docs refresh command added in #458. During refresh, the script temporarily removes the target version from
website/versions.jsonbefore rebuilding it. The Docusaurus config was still hard-coding labels for0.2.0and0.1.0, so Docusaurus could reject that transient state as an unknown version.The config now reads
website/versions.jsonand only applies release-line labels for versions that are currently present.Related Issues
Follow-up to #458.
Type of Change
Risk and Compatibility
Low risk. Public docs routes and labels remain unchanged during normal builds. This only makes the config tolerate the temporary
versions.jsonstate used bydocs-refresh-version.Verification
npm --prefix website run typecheckwebsite/scripts/refresh-version.mjs 0.2.0, verifyingversions.jsonorder stays0.2.0,0.1.0npm --prefix website run buildgit diff --checkmake lint-ciReviewer Notes
This same fix is already included in the
release-0.2backport PR #460 because the bug was found while validating that branch.Checklist